Scenario #2010: Create Self Debitor for Partner with Distinct Contact Data

UseCase Create Self Debitor For Partner => Debitor: D-3101000 - Test AG - main debitor

Properties

Required

Given

name value
partnerPersonTradeName Test AG
billingContactCaption Test AG - billing department
billingContactEmailAddress billing@test-ag.example.org
debitorNumberSuffix 00
billable true
vatId VAT123456
vatCountryCode DE
vatBusiness true
vatReverseCharge false
defaultPrefix tst

partnerPersonUuid

HTTP GET "/api/hs/office/relations?relationType=PARTNER&personData=Test+AG" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "da7c6690-455b-404c-aac3-fa98660e5a7d", // partnerRelationUuid
  "anchor" : {
    "uuid" : "8f6b2e83-5cd0-4f3b-bac9-c56b374445cf", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "3029ef4b-ab91-429d-855b-26a8bedcef6e", // Person: Test AG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Test AG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "ab067924-4231-4dce-a465-f768d7d54c2a", // Contact: Test AG - China
    "caption" : "Test AG - China",
    "postalAddress" : {
      "country" : "China",
      "province" : "Guangdong Province",
      "city" : "Dongguan City",
      "street" : "No.2 Commercial Second Street",
      "district" : "Niushan Wei Wu",
      "department" : "Executive Board",
      "building" : "Thi Chi Koh Building"
    },
    "emailAddresses" : {
      "main" : "norden@test-ag.example.org"
    },
    "phoneNumbers" : {
      "phone" : "++15 999 654321"
    }
  }
} ]

In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.

BankAccount: Test AG - refund bank account

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "holder" : "Test AG - refund bank account",
  "iban" : "DE88100900001234567892",
  "bic" : "BEVODEBB"
}
EOF
=> status: 201 CREATED 59c0f2b0-f6eb-411f-bfee-2f49a0cb8836

Contact: Test AG - billing department

HTTP POST "/api/hs/office/contacts" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "caption" : "Test AG - billing department",
  "emailAddresses" : {
    "main" : "billing@test-ag.example.org"
  }
}
EOF
=> status: 201 CREATED 9e812bae-fd7b-45a1-9be4-e1265b41eeca

Create Debitor: D-3101000 - Test AG - main debitor

HTTP POST "/api/hs/office/debitors" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "3029ef4b-ab91-429d-855b-26a8bedcef6e", // partnerPersonUuid
    "holder.uuid" : "3029ef4b-ab91-429d-855b-26a8bedcef6e", // partnerPersonUuid
    "contact.uuid" : "9e812bae-fd7b-45a1-9be4-e1265b41eeca" // Contact: Test AG - billing department
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatId" : "VAT123456",
  "vatCountryCode" : "DE",
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "59c0f2b0-f6eb-411f-bfee-2f49a0cb8836", // BankAccount: Test AG - refund bank account
  "defaultPrefix" : "tst"
}
EOF
=> status: 201 CREATED 87bc5864-52cd-4738-94f4-a986db8c7674

generated on 2026-08-10 03:08:30 for branch HEAD